Code Coverage for /srv/pim/src/Akeneo/Pim/Enrichment/Bundle/Elasticsearch/ProductQueryBuilderFactory.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	100.00% covered (success)	100.00%	1 / 1	100.00% covered (success)	100.00%	6 / 6	CRAP	100.00% covered (success)	100.00%	64 / 64
ProductQueryBuilderFactory	100.00% covered (success)	100.00%	1 / 1	100.00% covered (success)	100.00%	6 / 6	12	100.00% covered (success)	100.00%	64 / 64
__construct				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	7 / 7
create				100.00% covered (success)	100.00%	1 / 1	6	100.00% covered (success)	100.00%	16 / 16
createProductQueryBuilder				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	8 / 8
resolveOptions				100.00% covered (success)	100.00%	1 / 1	2	100.00% covered (success)	100.00%	10 / 10
configureOptions				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	16 / 16
configureFilterOptions				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	7 / 7

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Akeneo\Pim\Enrichment\Bundle\Elasticsearch;
6
7	use Akeneo\Pim\Enrichment\Component\Product\Model\Product;
8	use Akeneo\Pim\Enrichment\Component\Product\Model\ProductInterface;
9	use Akeneo\Pim\Enrichment\Component\Product\Model\ProductModelInterface;
10	use Akeneo\Pim\Enrichment\Component\Product\Query\Filter\FilterRegistryInterface;
11	use Akeneo\Pim\Enrichment\Component\Product\Query\Filter\Operators;
12	use Akeneo\Pim\Enrichment\Component\Product\Query\ProductQueryBuilderFactoryInterface;
13	use Akeneo\Pim\Enrichment\Component\Product\Query\ProductQueryBuilderInterface;
14	use Akeneo\Pim\Enrichment\Component\Product\Query\ProductQueryBuilderOptionsResolverInterface;
15	use Akeneo\Pim\Enrichment\Component\Product\Query\Sorter\SorterRegistryInterface;
16	use Akeneo\Pim\Structure\Component\Repository\AttributeRepositoryInterface;
17	use Akeneo\Tool\Component\StorageUtils\Cursor\CursorFactoryInterface;
18	use Symfony\Component\OptionsResolver\OptionsResolver;
19
20	/**
21	* Aims to wrap the creation and configuration of the product query builder
22	*
23	* @author Nicolas Dupont <nicolas@akeneo.com>
24	* @copyright 2014 Akeneo SAS (http://www.akeneo.com)
25	* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
26	*/
27	class ProductQueryBuilderFactory implements ProductQueryBuilderFactoryInterface
28	{
29	/** @var string */
30	protected $pqbClass;
31
32	/** @var AttributeRepositoryInterface */
33	protected $attributeRepository;
34
35	/** FilterRegistryInterface */
36	protected $filterRegistry;
37
38	/** SorterRegistryInterface */
39	protected $sorterRegistry;
40
41	/** CursorFactoryInterface */
42	protected $cursorFactory;
43
44	/** @var ProductQueryBuilderOptionsResolverInterface */
45	protected $optionsResolver;
46
47	/**
48	* @param string $pqbClass
49	* @param AttributeRepositoryInterface $attributeRepository
50	* @param FilterRegistryInterface $filterRegistry
51	* @param SorterRegistryInterface $sorterRegistry
52	* @param CursorFactoryInterface $cursorFactory
53	* @param ProductQueryBuilderOptionsResolverInterface $optionsResolver
54	*/
55	public function __construct(
56	string $pqbClass,
57	AttributeRepositoryInterface $attributeRepository,
58	FilterRegistryInterface $filterRegistry,
59	SorterRegistryInterface $sorterRegistry,
60	CursorFactoryInterface $cursorFactory,
61	ProductQueryBuilderOptionsResolverInterface $optionsResolver
62	) {
63	$this->pqbClass = $pqbClass;
64	$this->attributeRepository = $attributeRepository;
65	$this->filterRegistry = $filterRegistry;
66	$this->sorterRegistry = $sorterRegistry;
67	$this->cursorFactory = $cursorFactory;
68	$this->optionsResolver = $optionsResolver;
69	}
70
71	/**
72	* {@inheritdoc}
73	*/
74	public function create(array $options = []): ProductQueryBuilderInterface
75	{
76	$options = $this->resolveOptions($options);
77
78	$pqbOptions = [
79	'locale' => $options['default_locale'],
80	'scope' => $options['default_scope'],
81	];
82
83	if (isset($options['limit'])) {
84	$pqbOptions['limit'] = $options['limit'];
85	}
86
87	if (isset($options['search_after'])) {
88	$pqbOptions['search_after'] = $options['search_after'];
89	}
90
91	if (isset($options['search_after_unique_key'])) {
92	$pqbOptions['search_after_unique_key'] = $options['search_after_unique_key'];
93	}
94
95	if (isset($options['from'])) {
96	$pqbOptions['from'] = $options['from'];
97	}
98
99	$pqb = $this->createProductQueryBuilder($pqbOptions);
100	$pqb->setQueryBuilder(new SearchQueryBuilder());
101
102	foreach ($options['filters'] as $filter) {
103	$pqb->addFilter($filter['field'], $filter['operator'], $filter['value'], $filter['context']);
104	}
105
106	return $pqb;
107	}
108
109	/**
110	* @param array $options
111	*
112	* @return ProductQueryBuilderInterface
113	*/
114	protected function createProductQueryBuilder(array $options): ProductQueryBuilderInterface
115	{
116	$pqb = new $this->pqbClass(
117	$this->attributeRepository,
118	$this->filterRegistry,
119	$this->sorterRegistry,
120	$this->cursorFactory,
121	$this->optionsResolver,
122	$options
123	);
124
125	return $pqb;
126	}
127
128	/**
129	* @param array $options
130	*
131	* @return array
132	*/
133	protected function resolveOptions(array $options): array
134	{
135	$resolver = new OptionsResolver();
136	$this->configureOptions($resolver);
137	$options = $resolver->resolve($options);
138
139	$filterResolver = new OptionsResolver();
140	$this->configureFilterOptions($filterResolver);
141
142	$filters = $options['filters'];
143	$options['filters'] = [];
144	foreach ($filters as $filter) {
145	$options['filters'][] = $filterResolver->resolve($filter);
146	}
147
148	return $options;
149	}
150
151	/**
152	* @param OptionsResolver $resolver
153	*/
154	protected function configureOptions(OptionsResolver $resolver): void
155	{
156	$resolver->setDefined([
157	'repository_method',
158	'repository_parameters',
159	'currentGroup',
160	'product',
161	'default_locale',
162	'default_scope',
163	'filters',
164	'search_after',
165	'search_after_unique_key',
166	'limit',
167	'from'
168	]);
169	$resolver->setDefaults([
170	'repository_method' => 'createQueryBuilder',
171	'repository_parameters' => ['o'],
172	'default_locale' => null,
173	'default_scope' => null,
174	'filters' => [],
175	]);
176	$resolver->setAllowedTypes('repository_method', 'string');
177	$resolver->setAllowedTypes('repository_parameters', 'array');
178	$resolver->setAllowedTypes('currentGroup', 'string');
179	$resolver->setAllowedTypes('product', 'string');
180	$resolver->setAllowedTypes('default_locale', ['string', 'null']);
181	$resolver->setAllowedTypes('default_scope', ['string', 'null']);
182	$resolver->setAllowedTypes('search_after', 'array');
183	$resolver->setAllowedTypes('search_after_unique_key', ['string', 'null']);
184	$resolver->setAllowedTypes('limit', 'int');
185	$resolver->setAllowedTypes('filters', 'array');
186	$resolver->setAllowedTypes('from', 'int');
187	}
188
189	/**
190	* @param OptionsResolver $resolver
191	*/
192	protected function configureFilterOptions(OptionsResolver $resolver): void
193	{
194	$resolver
195	->setRequired(['field', 'operator', 'value'])
196	->setDefined(['context', 'type'])
197	->setDefaults([
198	'context' => [],
199	'type' => '',
200	])
201	->setAllowedTypes('context', 'array')
202	->setAllowedTypes('type', 'string')
203	;
204	}
205	}